home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / bbs / tg_302.zip / RELEASE.DOC < prev   
Text File  |  1996-07-14  |  16KB  |  299 lines
  1.         
  2.                   Telegard Bulletin Board Software, v3.02
  3.                            RELEASE Documentation
  4.  
  5.                       Copyright (C) 1996 by Tim Strike
  6.                             All Rights Reserved.
  7.  
  8.  
  9.        These are just notes that I have compiled over time with regards to
  10.        the many questions I get asked daily.  This is not a F.A.Q., but
  11.        is a way of explaining how and why certain things work the way they
  12.        do with Telegard.  It will be continually updated.  New topics (from
  13.        release to release) will be marked with a "|" pipe character along
  14.        the left margin.
  15.  
  16.        REFERENCE FILES AND DOCUMENTATION
  17.        
  18.          * Telegard includes some small reference files in /notes/, all
  19.            with the extension of *.REF.  These files cover various aspects
  20.            of the system, included ACS commands, COLOUR commands, MCI 
  21.            codes, MENU commands, SCRIPT commands, SYSOP FUNCTION keys, TEXT
  22.            files and the command line options for Telegard.
  23.         
  24.          * Telegard documentation has not been completed at the time of
  25.            the release of gamma-3.  Our goal is to complete the 
  26.            documentation for the final 3.0 release.  In the mean time, 
  27.            Kevin Watkins has done a fine job on the pre-release 
  28.            documentation, which is distributed in it's current form as 
  29.            TELEGARD.DOC.
  30.  
  31.        
  32.        UTILITIES
  33.  
  34.          * INDEX.EXE was not designed to be run while a user is online; 
  35.            this is for several reasons, but main reason is it modifies 
  36.            files which the online user will access at some point.  Indexing 
  37.            should *ONLY* be run when a user is *NOT* online.  This goes for 
  38.            single or multinode setups.
  39.  
  40.          * USERS.EXE allows you to pack away deleted users (unlike 2.7, 
  41.            Telegard 3.0 does not automatically reuse deleted accounts).  
  42.            USERS.EXE also allows sorting of the userbase -- first it sorts
  43.            by security level, and then it sorts by user name within each
  44.            security level echelon.
  45.  
  46.  
  47.        MAINTENANCE
  48.  
  49.          * Telegard is, for the most part, self-maintaining.  The index 
  50.            files are designed to work without interruption and most of the
  51.            data files automatically handle packing and removal of unused
  52.            records.
  53.  
  54.            That said, the Telegard index files do require some maintenance
  55.            to maintain top performance.  It is recommended that you:
  56.  
  57.                 (i) Run INDEX SORT ALL on a nightly schedule 
  58.                (ii) Run INDEX BUILD ALL on a weekly schedule, if not
  59.                         every couple of days
  60.  
  61.  
  62.        LANGUAGES
  63.        
  64.          * Telegard 3.0 no longer has an internal strings list.  All 
  65.            strings are stored in an external language file (the default of
  66.            which is ENGLISH.TXT in /language/).  To change this file, use
  67.            a text editor which does *not* strip spaces from the end of a
  68.            line (Qedit with said option disabled works well).  After 
  69.            changing any language file, you must recompile it.  From your
  70.            /language/ directory, run "C:\BBS\LANGUAGE\MAKELANG <language>"
  71.            and this will compile your new language strings.
  72.            
  73.          * The language system is fairly extensive, and just about every
  74.            user-viewable string can be configured in any manner you like.
  75.            For more information, see the header in ENGLISH.TXT, and don't
  76.            forget about the *.REF files in /notes/.
  77.  
  78.        
  79.        MESSAGES
  80.        
  81.          * Telegard uses JAM and Squish message bases because they are 
  82.            standardized.  Standardized formats allow external utilities to 
  83.            easily work with Telegard, without the need of a conversion 
  84.            program (/a la TELEMAIL).  For these reasons as well, I have not 
  85.            taken the time to develop a message base packer for Telegard -- 
  86.            it's development time that I just don't have.
  87.            
  88.            There are several external packers available -- some with 
  89.            freeware/evaluation packages, others with shareware packages:
  90.            
  91.                Gecho 1.10+       Registered Only    MBUTIL     JAM
  92.                FastEcho 1.45a    Shareware          FEUTILS    JAM
  93.                Fmail 1.02g       Shareware          FTOOLS     JAM
  94.                Squish 1.11       Shareware          SQPACK     Squish
  95.          
  96.          * File attaches are enabled in Telegard, but the popular JAM 
  97.            tossers do not support or do not correctly support incoming
  98.            and outgoing messages.  I suggest limiting attaches to local
  99.            bases *ONLY* for now.
  100.  
  101.          * Editing of messages will *not* be added to Telegard.  I have my 
  102.            personal reasons, and while I realize that it is an often 
  103.            requested feature, I refuse to submerge my values for others on 
  104.            everything -- I will implement some features I don't agree with, 
  105.            this won't be one of them!
  106.            
  107.            Setup an external SysOp editor (TimEd, GoldEd, etc) to the 
  108.            editing of messages if you so desire.  Or export/capture the 
  109.            message, delete the post, and resend it.
  110.        
  111.      |   * Message bases only update the lastread pointer if using the
  112.      |     NEWSCAN option.  This is done *on purpose*.  Reading forwards
  113.      |     through a base, or for that matter, reverse, would cause the
  114.      |     highread to be set when it wasn't meant to be set.  This is not
  115.      |     a bug, and infact, is a rather useful and powerful feature 
  116.      |     (which I won't change now or in the future -- sorry).
  117.  
  118.          * Internal full screen editing will *not* be added to Telegard in 
  119.            the near future.  My development time is limited to new features 
  120.            -- since many FSE programs already exist, some with extended TG3 
  121.            support, I refuse to re-invent the wheel while I have other 
  122.            areas of concern.                                         
  123.          
  124.          * However, Telegard works quite well with external FSE programs!
  125.            Telegard 3.0 has been tested with IceEdit (v1.50, Ice 
  126.            Technologies, 1:259/912), Gedit (v2.10, The Developers Network, 
  127.            1:170/303) and QuickEd (v1.nn, Dror Tirosh).  Other FSE programs 
  128.            have not been tested, and may not work that well with Telegard
  129.            (i.e. TopEd and it's awkward multinode configuration/expectations)
  130.            
  131.  
  132.        PROTOCOLS AND ARCHIVERS (and for that matter, MODEMS)
  133.  
  134.          * Telegard uses an advanced setup mechanism for protocols, 
  135.            archivers and modems.  We provide working setups which have been 
  136.            tested for the most popular products, and allow you to quickly 
  137.            import these setups and us as-is.  Most of these setups do not 
  138.            require any form of modification.
  139.  
  140.            To import the release setups for protocols, archivers and 
  141.            modems, goto the respective area, select the item to define, 
  142.            select option (!)Definition Files, select (I)mport and select 
  143.            the correct item to import.  Telegard gamma-3 also prompts when 
  144.            adding/deleting these items if you wish to import a pre-define 
  145.            definition.
  146.  
  147.            If at all possible, DO THIS.  It will save you many headaches
  148.            when trying to setup these external programs on your system.
  149.         
  150.          * LHA troubleshooting -- If you are using LHA/LZH on your system, 
  151.            make sure you run a version which is compatible with extracting 
  152.            to a specific path.  I personally use LHA 2.05.  If you have 
  153.            problems unpacking mail/files from an LHA archive -- then try 
  154.            changing ~AP to ~AP\ in the definition, and if it *still* 
  155.            doesn't work, try removing ~AP entirely from the definition.
  156.  
  157.          * RAR troubleshooting -- RAR encrypted archive handling (archives 
  158.            w/ file pa